home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 September / macformat-028.iso / mac / Shareware City / Comms / Quark to HTML / README < prev   
Encoding:
Text File  |  1995-03-03  |  3.4 KB  |  81 lines  |  [TEXT/ttxt]

  1. qt2www: Quark Tags to WWW
  2. Version: 1.0 Beta
  3.  
  4. This is rough documentation for qt2www, which converts text marked
  5. with Quark XPress Tags to HTML. This program is a general-purpose
  6. conversion utility; it reads in a map file that lists the Quark Tags
  7. used in the source file and how they should be translated into HTML.
  8.  
  9. Version 1.0 beta supercedes Version 0.13 for UNIX and Version 0.9.6 for
  10. Macintosh. The new version adds all the features of the UNIX version to
  11. the Macintosh release; the Macintosh version is now a droplet. Finally, 
  12. there have been several internal changes to the code. I don't expect too
  13. many problems, because earlier versions worked smoothly.
  14.  
  15. I assume that you know how to export text from Quark XPress as Quark
  16. Tags. Check your Quark manual if you don't know how to do this.
  17.  
  18. The converter is a droplet. Select some express tag files, then drag-and-drop
  19. them onto the Quark to HTML icon. Files with the same name, but with a .html
  20. extension added, will be created in the directory that contains the source files.
  21.  
  22. The hard part of using the program is setting up the map
  23. file. Unfortunately, I can't provide that for you. Quark Tags are user
  24. defined. When you create a Quark document with style sheets, each of
  25. the styles becomes a Quark Tag.  So if you create a style called
  26. "Body", then your map file must have an entry for the style "Body".
  27.  
  28. The map file is a plain text file. Each entry has four fields which can be
  29. tab or comma delimited. The first entry is the name of the style. The second
  30. field is the HTML markup (e.g. H2, H3, ADDRESS) to use for this style; you
  31. can also specify the markup Normal, which means that no markup is used for
  32. the style. The third field is the HTML seperator to be used between paragraphs;
  33. this can either be P or BR. The fourth field, which is optional, specifies
  34. highlights for the style -- bold and italic are support.
  35.  
  36. The map *must* be in the same directory as the Quark to HTML program.
  37.  
  38. Here are some examples:
  39.  
  40. Map entry: Headline,H2,P
  41. Quark source: @Headline: This is a headline
  42. Output: <H2>This is a headline</H2>
  43.  
  44. Map entry: Body,Normal,P,I
  45. Quark source: @Body: This is some body text.
  46. Output: <P><I>This is some body text.</I></P>
  47.  
  48. Map entry: List,Normal,BR
  49. Quark source: @List: List item 1
  50. List item 2
  51. List item 3
  52. Output: List item 1<BR>List item 2<BR>List item 3<BR>
  53.  
  54. Comments can be placed in the map file by beginning the line with a
  55. hash mark, '#'. 
  56.  
  57. There are also two things you may need to do to the qt2www.pl script
  58. to get things working. First, be sure that the first line contains the
  59. correct location of your Perl executable file. By default, qt2www.pl
  60. looks for /usr/local/bin/perl.  Second, you can choose to suppress the
  61. status message that are normally generated with the script runs. To
  62. suppress the message, change the value of the variable $status_output
  63. to 'no' (or anything else); message will be printed only if the
  64. variable is set to 'yes'.
  65.  
  66. That's it for documentation at this point. If you have further questions or
  67. problems, send me email. I'll try to help and I'll add whatever I can to future
  68. versions of this file.
  69.  
  70. This program was developed at The Tech, MIT's student newspaper. It is
  71. based on a program called q2w3.pl, developed by the present writer and
  72. Reuven Lerner, with help from Ernst Smith. q2w3 was very spefically
  73. tied to The Tech's WWW server, and this program was developed to try
  74. to make that program useful to a wider audience.
  75.  
  76. Jeremy Hylton
  77. jeremy@the-tech.mit.edu
  78.  
  79.  
  80.  
  81.